

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Web API &mdash; IVRE  documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
      <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />

  
      <script src="../_static/jquery.js?v=5d32c60e"></script>
      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="../_static/documentation_options.js?v=5929fcd5"></script>
      <script src="../_static/doctools.js?v=9bcbadda"></script>
      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Tests" href="tests.html" />
    <link rel="prev" title="Development" href="index.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html" class="icon icon-home">
            IVRE
              <img src="../_static/logo.png" class="logo" alt="Logo"/>
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Overview</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../install/index.html">Installation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../usage/index.html">Usage</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Development</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Web API</a></li>
<li class="toctree-l2"><a class="reference internal" href="tests.html">Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="linting.html">Code linting</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Licenses:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../license.html">IVRE: GPL v3</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license-external.html">Licenses for external files</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">IVRE</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="index.html">Development</a></li>
      <li class="breadcrumb-item active">Web API</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/dev/web-api.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="web-api">
<h1>Web API<a class="headerlink" href="#web-api" title="Link to this heading"></a></h1>
<dl class="http get">
<dt class="sig sig-object http" id="get--config">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/config</span></span><a class="headerlink" href="#get--config" title="Link to this definition"></a></dt>
<dd><p>Returns JavaScript code to set client-side configuration values</p>
<dl class="field-list simple">
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>config</strong> (<em>object</em>) – the configuration values</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--(subdb-re-scans|view)-(action-re-onlyips|ipsports|timeline|coordinates|countopenports|diffcats)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view)/(action:re:onlyips|ipsports|timeline|coordinates|countopenports|diffcats)</span></span><a class="headerlink" href="#get--(subdb-re-scans|view)-(action-re-onlyips|ipsports|timeline|coordinates|countopenports|diffcats)" title="Link to this definition"></a></dt>
<dd><p>Get special values from Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
<li><p><strong>action</strong> (<em>str</em>) – specific value to get (must be one of “onlyips”,
“ipsports”, “timeline”, “coordinates”, “countopenports”
or “diffcats”)</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results (forces “json”
format)</p></li>
<li><p><strong>ipsasnumbers</strong> (<em>bool</em>) – to get IP addresses as numbers rather than as
strings</p></li>
<li><p><strong>datesasstrings</strong> (<em>bool</em>) – to get dates as strings rather than as
timestamps</p></li>
<li><p><strong>format</strong> (<em>str</em>) – “json” (the default), “ndjson” or “txt”</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Array of Objects<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>object</strong> – results</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--(subdb-re-scans|view)-count">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view)/count</span></span><a class="headerlink" href="#get--(subdb-re-scans|view)-count" title="Link to this definition"></a></dt>
<dd><p>Get special values from Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>int</strong> – count</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--(subdb-re-scans|view|passive)-top-(field-path)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view|passive)/top/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">field:</span> </em><em class="sig-param"><span class="pre">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--(subdb-re-scans|view|passive)-top-(field-path)" title="Link to this definition"></a></dt>
<dd><p>Get top values from Nmap, View &amp; Passive databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
<li><p><strong>field</strong> (<em>str</em>) – (pseudo-)field to get top values (e.g., “service”)</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
<li><p><strong>ipsasnumbers</strong> (<em>bool</em>) – to get IP addresses as numbers rather than as
strings</p></li>
<li><p><strong>datesasstrings</strong> (<em>bool</em>) – to get dates as strings rather than as
timestamps</p></li>
<li><p><strong>format</strong> (<em>str</em>) – “json” (the default) or “ndjson”</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Array of Objects<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>label</strong> (<em>str</em>) – field value</p></li>
<li><p><strong>value</strong> (<em>int</em>) – count for this value</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--(subdb-re-scans|view|passive)-distinct-(field-path)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view|passive)/distinct/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">field:</span> </em><em class="sig-param"><span class="pre">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--(subdb-re-scans|view|passive)-distinct-(field-path)" title="Link to this definition"></a></dt>
<dd><p>Get distinct values from Nmap, View &amp; Passive databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
<li><p><strong>field</strong> (<em>str</em>) – (pseudo-)field to get distinct values (e.g., “service”)</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
<li><p><strong>ipsasnumbers</strong> (<em>bool</em>) – to get IP addresses as numbers rather than as
strings</p></li>
<li><p><strong>datesasstrings</strong> (<em>bool</em>) – to get dates as strings rather than as
timestamps</p></li>
<li><p><strong>format</strong> (<em>str</em>) – “json” (the default) or “ndjson”</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Array of Objects<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>label</strong> (<em>str</em>) – field value</p></li>
<li><p><strong>value</strong> (<em>int</em>) – count for this value</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--(subdb-re-scans|view)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view)</span></span><a class="headerlink" href="#get--(subdb-re-scans|view)" title="Link to this definition"></a></dt>
<dd><p>Get records from Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
<li><p><strong>ipsasnumbers</strong> (<em>bool</em>) – to get IP addresses as numbers rather than as
strings</p></li>
<li><p><strong>datesasstrings</strong> (<em>bool</em>) – to get dates as strings rather than as
timestamps</p></li>
<li><p><strong>format</strong> (<em>str</em>) – “json” (the default) or “ndjson”</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Array of Objects<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>object</strong> – results</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http post">
<dt class="sig sig-object http" id="post--(subdb-re-scans|view)">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/(subdb:re:scans|view)</span></span><a class="headerlink" href="#post--(subdb-re-scans|view)" title="Link to this definition"></a></dt>
<dd><p>Add records to Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subdb</strong> (<em>str</em>) – database to query (must be “scans” or “view”)</p></li>
</ul>
</dd>
<dt class="field-even">Form Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>categories</strong> – a coma-separated list of categories</p></li>
<li><p><strong>source</strong> – the source of the scan results (mandatory)</p></li>
<li><p><strong>result</strong> – scan results (as XML or JSON files)</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer, source or username missing</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>count</strong> (<em>int</em>) – number of inserted results</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--flows">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/flows</span></span><a class="headerlink" href="#get--flows" title="Link to this definition"></a></dt>
<dd><p>Get special values from Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Query Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (including limit/skip, orderby, etc.)</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
<li><p><strong>action</strong> (<em>str</em>) – can be set to “details”</p></li>
</ul>
</dd>
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-odd">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>object</strong> – results</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--ipdata-(addr)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/ipdata/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">addr</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--ipdata-(addr)" title="Link to this definition"></a></dt>
<dd><p>Returns (estimated) geographical and AS data for a given IP address.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>addr</strong> (<em>str</em>) – IP address to query</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>object</strong> – the result values</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--passivedns-(query-path)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/passivedns/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">query:</span> </em><em class="sig-param"><span class="pre">path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--passivedns-(query-path)" title="Link to this definition"></a></dt>
<dd><p>Query passive DNS data. This API is compatible with the <a class="reference external" href="https://datatracker.ietf.org/doc/draft-dulaunoy-dnsop-passive-dns-cof/">Common
Output Format</a>
and implemented in CIRCL’s <a class="reference external" href="https://github.com/CIRCL/PyPDNS">PyPDNS</a>.</p>
<p>It accepts two extra parameters, not supported (yet?) in PyPDNS:</p>
<blockquote>
<div><ul class="simple">
<li><p><cite>subdomains</cite>: if this parameter exists and a domain name is
queried, records for any subdomains will also be returned.</p></li>
<li><p><cite>reverse</cite>: if this parameter exists and a domain name is queried,
records pointing to the queried domain (CNAME, NS, MX) will be
returned.</p></li>
</ul>
</div></blockquote>
<p>It also returns additional information:</p>
<blockquote>
<div><ul class="simple">
<li><p>“sensor”: the “sensor” field of the record; this is useful to know
where this answer has been seen.</p></li>
<li><p>“source”: the IP address of the DNS server sending the answer.</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>query</strong> (<em>str</em>) – IP address or domains name to query</p></li>
</ul>
</dd>
<dt class="field-even">Query Parameters<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>subdomains</strong> (<em>bool</em>) – query subdomains (domain name only)</p></li>
<li><p><strong>reverse</strong> (<em>bool</em>) – use a reverse query (domain name only)</p></li>
<li><p><strong>type</strong> (<em>str</em>) – specify the DNS query type</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>object</strong> – the result values (JSONL format: one JSON result per line)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--passive">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/passive</span></span><a class="headerlink" href="#get--passive" title="Link to this definition"></a></dt>
<dd><p>Get records from Passive database</p>
<dl class="field-list simple">
<dt class="field-odd">Query Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (only used for limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
<li><p><strong>ipsasnumbers</strong> (<em>bool</em>) – to get IP addresses as numbers rather than as
strings</p></li>
<li><p><strong>datesasstrings</strong> (<em>bool</em>) – to get dates as strings rather than as
timestamps</p></li>
<li><p><strong>format</strong> (<em>str</em>) – “json” (the default) or “ndjson”</p></li>
</ul>
</dd>
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-odd">Response JSON Array of Objects<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>object</strong> – results</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="http get">
<dt class="sig sig-object http" id="get--passive-count">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/passive/count</span></span><a class="headerlink" href="#get--passive-count" title="Link to this definition"></a></dt>
<dd><p>Get special values from Nmap &amp; View databases</p>
<dl class="field-list simple">
<dt class="field-odd">Query Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>q</strong> (<em>str</em>) – query (only used for limit/skip and sort)</p></li>
<li><p><strong>f</strong> (<em>str</em>) – filter</p></li>
<li><p><strong>callback</strong> (<em>str</em>) – callback to use for JSONP results</p></li>
</ul>
</dd>
<dt class="field-even">Status Codes<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – no error</p></li>
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a></span> – invalid referer</p></li>
</ul>
</dd>
<dt class="field-odd">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>int</strong> – count</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="index.html" class="btn btn-neutral float-left" title="Development" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="tests.html" class="btn btn-neutral float-right" title="Tests" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2011 - 2025, Pierre LALET.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>